<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>ascend.post_process.color API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<link rel="preconnect" href="https://www.google.com">
<script async src="https://cse.google.com/cse.js?cx=017837193012385208679:pey8ky8gdqw"></script>
<style>
.gsc-control-cse {padding:0 !important;margin-top:1em}
body.gsc-overflow-hidden #sidebar {overflow: visible;}
</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
<style>.homelink{display:block;font-size:2em;font-weight:bold;color:#555;padding-bottom:.5em;border-bottom:1px solid silver}.homelink:hover{color:inherit}.homelink img{max-width:20%;max-height:5em;margin:auto;margin-bottom:.3em}</style>
<link rel="canonical" href="https://bazige.github.io/ascend/post_process/color.html">
<link rel="icon" href="https://bazige.github.io/ascend/logo/logo.png"">
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>ascend.post_process.color</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/pdoc3/pdoc/blob/37c907488ff52b174ab602690d1166f28bded9a2/ascend/post_process/color.py#L0-L89" class="git-link">Browse git</a>
</summary>
<pre><code class="python"># Copyright (c) Open-MMLab. All rights reserved.
from enum import Enum

import numpy as np

from ..common.path import is_str


class Color(Enum):
    &#34;&#34;&#34;An enum that defines common colors.

    Contains `red`, `green`, `blue`, `cyan`, `yellow`, `magenta`, `white` and `black`.
    &#34;&#34;&#34;
    red = (0, 0, 255)
    green = (0, 255, 0)
    blue = (255, 0, 0)
    cyan = (255, 255, 0)
    yellow = (0, 255, 255)
    magenta = (255, 0, 255)
    white = (255, 255, 255)
    black = (0, 0, 0)


def color_val(color):
    &#34;&#34;&#34;Convert various input to color tuples.

    Args:
        color (`Color`/str/tuple/int/ndarray): Color inputs

    Returns:
        tuple[int]: A tuple of 3 integers indicating BGR channels.
    &#34;&#34;&#34;
    if is_str(color):
        return Color[color].value
    elif isinstance(color, Color):
        return color.value
    elif isinstance(color, tuple):
        assert len(color) == 3
        for channel in color:
            assert 0 &lt;= channel &lt;= 255
        return color
    elif isinstance(color, int):
        assert 0 &lt;= color &lt;= 255
        return color, color, color
    elif isinstance(color, np.ndarray):
        assert color.ndim == 1 and color.size == 3
        assert np.all((color &gt;= 0) &amp; (color &lt;= 255))
        color = color.astype(np.uint8)
        return tuple(color)
    else:
        raise TypeError(f&#39;Invalid type for color: {type(color)}&#39;)

def color_gen(class_num):
    &#34;&#34;&#34;Convert various input to color tuples.

    Args:
        class_num (int): Class numbers

    Returns:
        list[int]: Generate colors according to class number.
    &#34;&#34;&#34;
    assert class_num &gt;= 0, f&#34;Input class_num should be larger than 0.&#34;
    gen_color = []
    for _ in range(class_num):
        color = np.random.randint(0, 255, size=3).tolist()
        gen_color.append(color)
    return gen_color


&#34;&#34;&#34;An array that defines common colors.

Contains various standard color.
&#34;&#34;&#34;
COLORS_81 = np.array([[0, 0, 0], [244, 67, 54], [233, 30, 99], [156, 39, 176], [103, 58, 183], [100, 30, 60],
            [63, 81, 181], [33, 150, 243], [3, 169, 244], [0, 188, 212], [20, 55, 200],
            [0, 150, 136], [76, 175, 80], [139, 195, 74], [205, 220, 57], [70, 25, 100],
            [255, 235, 59], [255, 193, 7], [255, 152, 0], [255, 87, 34], [90, 155, 50],
            [121, 85, 72], [158, 158, 158], [96, 125, 139], [15, 67, 34], [98, 55, 20],
            [21, 82, 172], [58, 128, 255], [196, 125, 39], [75, 27, 134], [90, 125, 120],
            [121, 82, 7], [158, 58, 8], [96, 25, 9], [115, 7, 234], [8, 155, 220],
            [221, 25, 72], [188, 58, 158], [56, 175, 19], [215, 67, 64], [198, 75, 20],
            [62, 185, 22], [108, 70, 58], [160, 225, 39], [95, 60, 144], [78, 155, 120],
            [101, 25, 142], [48, 198, 28], [96, 225, 200], [150, 167, 134], [18, 185, 90],
            [21, 145, 172], [98, 68, 78], [196, 105, 19], [215, 67, 84], [130, 115, 170],
            [255, 0, 255], [255, 255, 0], [196, 185, 10], [95, 167, 234], [18, 25, 190],
            [0, 255, 255], [255, 0, 0], [0, 255, 0], [0, 0, 255], [155, 0, 0],
            [0, 155, 0], [0, 0, 155], [46, 22, 130], [255, 0, 155], [155, 0, 255],
            [255, 155, 0], [155, 255, 0], [0, 155, 255], [0, 255, 155], [18, 5, 40],
            [120, 120, 255], [255, 58, 30], [60, 45, 60], [75, 27, 244], [128, 25, 70]], dtype=&#39;uint8&#39;)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="ascend.post_process.color.color_gen"><code class="name flex">
<span>def <span class="ident">color_gen</span></span>(<span>class_num)</span>
</code></dt>
<dd>
<div class="desc"><p>Convert various input to color tuples.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>class_num</code></strong> :&ensp;<code>int</code></dt>
<dd>Class numbers</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list[int]</code></dt>
<dd>Generate colors according to class number.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/pdoc3/pdoc/blob/37c907488ff52b174ab602690d1166f28bded9a2/ascend/post_process/color.py#L53-L67" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def color_gen(class_num):
    &#34;&#34;&#34;Convert various input to color tuples.

    Args:
        class_num (int): Class numbers

    Returns:
        list[int]: Generate colors according to class number.
    &#34;&#34;&#34;
    assert class_num &gt;= 0, f&#34;Input class_num should be larger than 0.&#34;
    gen_color = []
    for _ in range(class_num):
        color = np.random.randint(0, 255, size=3).tolist()
        gen_color.append(color)
    return gen_color</code></pre>
</details>
</dd>
<dt id="ascend.post_process.color.color_val"><code class="name flex">
<span>def <span class="ident">color_val</span></span>(<span>color)</span>
</code></dt>
<dd>
<div class="desc"><p>Convert various input to color tuples.</p>
<h2 id="args">Args</h2>
<p>color (<code><a title="ascend.post_process.color.Color" href="#ascend.post_process.color.Color">Color</a></code>/str/tuple/int/ndarray): Color inputs</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>tuple[int]</code></dt>
<dd>A tuple of 3 integers indicating BGR channels.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/pdoc3/pdoc/blob/37c907488ff52b174ab602690d1166f28bded9a2/ascend/post_process/color.py#L24-L51" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def color_val(color):
    &#34;&#34;&#34;Convert various input to color tuples.

    Args:
        color (`Color`/str/tuple/int/ndarray): Color inputs

    Returns:
        tuple[int]: A tuple of 3 integers indicating BGR channels.
    &#34;&#34;&#34;
    if is_str(color):
        return Color[color].value
    elif isinstance(color, Color):
        return color.value
    elif isinstance(color, tuple):
        assert len(color) == 3
        for channel in color:
            assert 0 &lt;= channel &lt;= 255
        return color
    elif isinstance(color, int):
        assert 0 &lt;= color &lt;= 255
        return color, color, color
    elif isinstance(color, np.ndarray):
        assert color.ndim == 1 and color.size == 3
        assert np.all((color &gt;= 0) &amp; (color &lt;= 255))
        color = color.astype(np.uint8)
        return tuple(color)
    else:
        raise TypeError(f&#39;Invalid type for color: {type(color)}&#39;)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="ascend.post_process.color.Color"><code class="flex name class">
<span>class <span class="ident">Color</span></span>
<span>(</span><span>value, names=None, *, module=None, qualname=None, type=None, start=1)</span>
</code></dt>
<dd>
<div class="desc"><p>An enum that defines common colors.</p>
<p>Contains <code>red</code>, <code>green</code>, <code>blue</code>, <code>cyan</code>, <code>yellow</code>, <code>magenta</code>, <code>white</code> and <code>black</code>.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/pdoc3/pdoc/blob/37c907488ff52b174ab602690d1166f28bded9a2/ascend/post_process/color.py#L9-L21" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class Color(Enum):
    &#34;&#34;&#34;An enum that defines common colors.

    Contains `red`, `green`, `blue`, `cyan`, `yellow`, `magenta`, `white` and `black`.
    &#34;&#34;&#34;
    red = (0, 0, 255)
    green = (0, 255, 0)
    blue = (255, 0, 0)
    cyan = (255, 255, 0)
    yellow = (0, 255, 255)
    magenta = (255, 0, 255)
    white = (255, 255, 255)
    black = (0, 0, 0)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>enum.Enum</li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="ascend.post_process.color.Color.black"><code class="name">var <span class="ident">black</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.blue"><code class="name">var <span class="ident">blue</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.cyan"><code class="name">var <span class="ident">cyan</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.green"><code class="name">var <span class="ident">green</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.magenta"><code class="name">var <span class="ident">magenta</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.red"><code class="name">var <span class="ident">red</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.white"><code class="name">var <span class="ident">white</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="ascend.post_process.color.Color.yellow"><code class="name">var <span class="ident">yellow</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<header>
<a class="homelink" rel="home" title="ascendfly Home" href="https://gitee.com/ascend-fae/ascendfly">
<img src="https://bazige.github.io/ascend/logo/logo.png" alt=""> ascendfly
</a>
</header>
<div class="gcse-search" style="height: 70px"
data-as_oq="site:bazige.github.io inurl:github.com/ascendfly"
data-gaCategoryParameter="ascend.post_process.color">
</div>
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="ascend.post_process" href="index.html">ascend.post_process</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="ascend.post_process.color.color_gen" href="#ascend.post_process.color.color_gen">color_gen</a></code></li>
<li><code><a title="ascend.post_process.color.color_val" href="#ascend.post_process.color.color_val">color_val</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="ascend.post_process.color.Color" href="#ascend.post_process.color.Color">Color</a></code></h4>
<ul class="two-column">
<li><code><a title="ascend.post_process.color.Color.black" href="#ascend.post_process.color.Color.black">black</a></code></li>
<li><code><a title="ascend.post_process.color.Color.blue" href="#ascend.post_process.color.Color.blue">blue</a></code></li>
<li><code><a title="ascend.post_process.color.Color.cyan" href="#ascend.post_process.color.Color.cyan">cyan</a></code></li>
<li><code><a title="ascend.post_process.color.Color.green" href="#ascend.post_process.color.Color.green">green</a></code></li>
<li><code><a title="ascend.post_process.color.Color.magenta" href="#ascend.post_process.color.Color.magenta">magenta</a></code></li>
<li><code><a title="ascend.post_process.color.Color.red" href="#ascend.post_process.color.Color.red">red</a></code></li>
<li><code><a title="ascend.post_process.color.Color.white" href="#ascend.post_process.color.Color.white">white</a></code></li>
<li><code><a title="ascend.post_process.color.Color.yellow" href="#ascend.post_process.color.Color.yellow">yellow</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p><span style="color:#ddd">&#21328;</span></p>
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>